ナビゲーション・リソース・メタデータの取得

get

/resources/v1/metadata-catalog/aggregates/{siteName}/navigation

リソース・エンドポイントは、"application/json"を指定したリクエストの場合、リソース名、リソースのJSONスキーマへのリンク、ナビゲーション・リソース・インスタンスへのリンクなどのリソースの説明を返します。"application/schema+json"を指定したリクエストの場合、リソースのJSONスキーマが返されます。デフォルトは、"application/json"です。注意: これは、ナビゲーション・リソース・インスタンスのOPTIONSリクエストから返されるメタデータURLです。

• リクエスト
• レスポンス
• 例

次の表に、クライアント・リクエストをまとめます。

パス・パラメータ

名前	説明	形式
siteName	サイトの名前	文字列

次の表に、サーバー・レスポンスをまとめます。

サポートされるメディア・タイプ

• application/json
• application/schema+json

200レスポンス

リソース・メタデータ。

例1

次の例に、cURLを使用してRESTリソースに対するGETリクエストを送信し、ナビゲーション・リソースの説明を取得する方法を示します。

curl -i -H "Accept: application/json" -X GET "http://<host>:<port>/<context>/REST/resources/v1/metadata-catalog/aggregates/avisports/navigation"

例1 レスポンス・ヘッダー

次の例に、レスポンス・ヘッダーを示します。

HTTP/1.1 200 OK
ETag: "0495efa4e9b8daeafa1438226583354b666143535445cf4b85d48f98e0e5f6bb" 
Cache-Control: max-age=0
Content-Type: application/json;charset=utf-8

例1 レスポンス本文

次の例に、JSON形式のレスポンス本文のコンテンツを示します。

{
  "name": "Aggregated Navigation Resource for entire site",
  "links": [
    {
      "href": "http://<host>:<port>/<context>/REST/resources/v1/metadata-catalog/aggregates/avisports/navigation",
      "rel": "alternate",
      "templated": false,
      "mediaType": "application/schema+json",
      "method": "GET",
      "profile": ""
    },
    {
      "href": "http://<host>:<port>/<context>/REST/resources/v1/metadata-catalog/aggregates/avisports/navigation",
      "rel": "canonical",
      "templated": false,
      "mediaType": "application/json",
      "method": "GET",
      "profile": ""
    },
    {
      "href": "http://<host>:<port>/<context>/REST/resources/v1/aggregates/avisports/navigation",
      "rel": "describes",
      "templated": false,
      "mediaType": "application/json",
      "method": "GET",
      "profile": ""
    }
  ]
}

例2

次の例に、cURLを使用してRESTリソースに対するGETリクエストを送信し、ナビゲーション・リソースのJSONスキーマを取得する方法を示します。

curl -i -H "Accept: application/schema+json" -X GET "http://<host>:<port>/<context>/REST/resources/v1/metadata-catalog/aggregates/avisports/navigation"

例2 レスポンス・ヘッダー

次の例に、レスポンス・ヘッダーを示します。

HTTP/1.1 200 OK
Cache-Control: max-age=0,no-cache,no-store
Content-Type: application/schema+json;charset=utf-8

例2 レスポンス本文

次の例に、JSON形式のレスポンス本文のコンテンツを示します。

{
  "$schema": "http://<host>:<port>/<context>/schema/singularResource#",
  "title": "Aggregated Navigation Asset Schema",
  "allOf": [
    {
      "$ref": "http://<host>:<port>/<context>/schema/singularResource#"
    },
    {
      "$ref": "#/definitions/aggregatedNavigationAsset"
    }
  ],
  "definitions": {
    "aggregatedNavigationAsset": {
      "additionalProperties": true,
      "properties": {
        "start": {
          "$ref": "http://<host>:<port>/<context>/schema/subSchemas#/definitions/assetId"
        }
      },
      "patternProperties": {
        ".+?:[0-9]+": {
          "$ref": "http://<host>:<port>/<context>/schema/subSchemas#/definitions/navigationAssetProperties"
        }
      },
      "required": [
        "start"
      ]
    }
  }
}